<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Home</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Home</h1>

    



    


    <h3>auth0-js 9.29.0</h3>










    




    <section>
        <article><p><img src="https://cdn.auth0.com/website/sdks/banners/auth0-js-banner.png" alt="Client Side JavaScript toolkot for Auth0 API"></p>
<p><img src="https://img.shields.io/npm/v/auth0-js" alt="Release">
<a href="https://codecov.io/gh/auth0/auth0.js"><img src="https://img.shields.io/codecov/c/github/auth0/auth0.js" alt="Codecov"></a>
<img src="https://img.shields.io/npm/dw/auth0-js" alt="Downloads">
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/:license-MIT-blue.svg?style=flat" alt="License"></a>
<a href="https://circleci.com/gh/auth0/auth0.js"><img src="https://img.shields.io/circleci/build/github/auth0/auth0.js" alt="CircleCI"></a></p>
<p>📚 <a href="#documentation">Documentation</a> - 🚀 <a href="#getting-started">Getting Started</a> - 💻 <a href="#api-reference">API Reference</a> - 💬 <a href="#feedback">Feedback</a></p>
<h2>Documentation</h2>
<ul>
<li><a href="https://auth0.com/docs/libraries/auth0js">Library docs</a> - a complete reference and examples.</li>
<li><a href="https://github.com/auth0/auth0.js/blob/master/example/">Sample App</a> - a sample application integrated with Auth0.</li>
<li><a href="https://github.com/auth0/auth0.js/blob/master/EXAMPLES.md">Examples</a> - code samples for common auth0-js authentication scenario's.</li>
<li><a href="https://www.auth0.com/docs">Docs site</a> - explore our docs site and learn more about Auth0.</li>
</ul>
<h2>Getting started</h2>
<h3>Installation</h3>
<p>From CDN:</p>
<pre class="prettyprint source lang-html"><code>&lt;!-- Latest patch release -->
&lt;script src=&quot;https://cdn.auth0.com/js/auth0/9.29.0/auth0.min.js&quot;>&lt;/script>
</code></pre>
<p>From <a href="https://npmjs.org">npm</a>:</p>
<pre class="prettyprint source lang-sh"><code>npm install auth0-js
</code></pre>
<p>After installing the <code>auth0-js</code> module using <a href="https://npmjs.org">npm</a>, you'll need to bundle it up along with all of its dependencies, or import it using:</p>
<pre class="prettyprint source lang-js"><code>import auth0 from 'auth0-js';
</code></pre>
<h3>Configure the SDK</h3>
<h4>auth0.WebAuth</h4>
<p>Provides support for all the authentication flows.</p>
<pre class="prettyprint source lang-js"><code>var auth0 = new auth0.WebAuth({
  domain: '{YOUR_AUTH0_DOMAIN}',
  clientID: '{YOUR_AUTH0_CLIENT_ID}'
});
</code></pre>
<h4>auth0.Authentication</h4>
<p>Provides an API client for the Auth0 Authentication API.</p>
<pre class="prettyprint source lang-js"><code>var auth0 = new auth0.Authentication({
  domain: '{YOUR_AUTH0_DOMAIN}',
  clientID: '{YOUR_AUTH0_CLIENT_ID}'
});
</code></pre>
<h4>auth0.Management</h4>
<p>Provides an API Client for the Auth0 Management API (only methods meant to be used from the client with the user token). You should use an <code>access_token</code> with the <code>https://YOUR_DOMAIN.auth0.com/api/v2/</code> audience to make this work. For more information, read <a href="https://auth0.com/docs/libraries/auth0js/v9#user-management">the user management section of the Auth0.js documentation</a>.</p>
<pre class="prettyprint source lang-js"><code>var auth0 = new auth0.Management({
  domain: '{YOUR_AUTH0_DOMAIN}',
  token: '{ACCESS_TOKEN_FROM_THE_USER}'
});
</code></pre>
<h2>API reference</h2>
<h3>auth0.webAuth</h3>
<ul>
<li><a href="https://auth0.github.io/auth0.js/WebAuth.html#WebAuth">constructor</a></li>
<li><a href="https://auth0.github.io/auth0.js/WebAuth.html#authorize">authorize(options)</a></li>
<li><a href="https://auth0.github.io/auth0.js/WebAuth.html#changePassword">changePassword(options)</a></li>
<li><a href="https://auth0.github.io/auth0.js/WebAuth.html#checkSession">checkSession(options, callback)</a></li>
<li><a href="https://auth0.github.io/auth0.js/WebAuth.html#login">login(options, callback)</a></li>
<li><a href="https://auth0.github.io/auth0.js/WebAuth.html#logout">logout(options)</a></li>
<li><a href="https://auth0.github.io/auth0.js/WebAuth.html#parseHash">parseHash(options, callback)</a></li>
<li><a href="https://auth0.github.io/auth0.js/WebAuth.html#passwordlessLogin">passwordlessLogin(options, callback)</a></li>
<li><a href="https://auth0.github.io/auth0.js/WebAuth.html#passwordlessStart">passwordlessStart(options, callback)</a></li>
<li><a href="https://auth0.github.io/auth0.js/WebAuth.html#passwordlessVerify">passwordlessVerify(options, callback)</a></li>
<li><a href="https://auth0.github.io/auth0.js/WebAuth.html#renderCaptcha">renderCaptcha(element, options, callback)</a></li>
<li><a href="https://auth0.github.io/auth0.js/WebAuth.html#renewAuth">renewAuth(options, callback)</a></li>
<li><a href="https://auth0.github.io/auth0.js/WebAuth.html#signup">signup(options, callback)</a></li>
<li><a href="https://auth0.github.io/auth0.js/WebAuth.html#signupAndAuthorize">signupAndAuthorize(options, callback)</a></li>
<li><a href="https://auth0.github.io/auth0.js/WebAuth.html#validateAuthenticationResponse">validateAuthenticationResponse(options, parsedHash, callback)</a></li>
</ul>
<h3>auth0.Authentication</h3>
<ul>
<li><a href="https://auth0.github.io/auth0.js/Authentication.html#buildAuthorizeUrl">buildAuthorizeUrl(options)</a></li>
<li><a href="https://auth0.github.io/auth0.js/Authentication.html#buildLogoutUrl">buildLogoutUrl(options)</a></li>
<li><a href="https://auth0.github.io/auth0.js/Authentication.html#delegation">delegation(options, callback)</a></li>
<li><a href="https://auth0.github.io/auth0.js/Authentication.html#getChallenge">getChallenge(callback)</a></li>
<li><a href="https://auth0.github.io/auth0.js/Authentication.html#getSSOData">getSSOData(withActiveDirectories, callback)</a></li>
<li><a href="https://auth0.github.io/auth0.js/Authentication.html#login">login(options, callback)</a></li>
<li><a href="https://auth0.github.io/auth0.js/Authentication.html#loginWithDefaultDirectory">loginWithDefaultDirectory(options, callback)</a></li>
<li><a href="https://auth0.github.io/auth0.js/Authentication.html#loginWithResourceOwner">loginWithResourceOwner(options, callback)</a></li>
<li><a href="https://auth0.github.io/auth0.js/Authentication.html#userInfo">userInfo(token, callback)</a></li>
</ul>
<h3>auth0.Management</h3>
<ul>
<li><a href="https://auth0.github.io/auth0.js/Management.html#getUser">getUser(userId, callback)</a></li>
<li><a href="https://auth0.github.io/auth0.js/Management.html#linkUser">linkUser(userId, secondaryUserId, callback)</a></li>
<li><a href="https://auth0.github.io/auth0.js/Management.html#patchUserAttributes">patchUserAttributes(userId, user, callback)</a></li>
<li><a href="https://auth0.github.io/auth0.js/Management.html#patchUserMetadata">patchUserMetadata(userId, userMetadata, callback)</a></li>
</ul>
<h2>Feedback</h2>
<h3>Contributing</h3>
<p>We appreciate feedback and contribution to this repo! Before you get started, please see the following:</p>
<ul>
<li><a href="https://github.com/auth0/open-source-template/blob/master/GENERAL-CONTRIBUTING.md">Auth0's general contribution guidelines</a></li>
<li><a href="https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md">Auth0's code of conduct guidelines</a></li>
</ul>
<h3>Raise an issue</h3>
<p>To provide feedback or report a bug, please <a href="https://github.com/auth0/auth0.js/issues">raise an issue on our issue tracker</a>.</p>
<h3>Vulnerability Reporting</h3>
<p>Please do not report security vulnerabilities on the public GitHub issue tracker. The <a href="https://auth0.com/responsible-disclosure-policy">Responsible Disclosure Program</a> details the procedure for disclosing security issues.</p>
<hr>
<p align="center">
  <picture>
    <source media="(prefers-color-scheme: light)" srcset="https://cdn.auth0.com/website/sdks/logos/auth0_light_mode.png"   width="150">
    <source media="(prefers-color-scheme: dark)" srcset="https://cdn.auth0.com/website/sdks/logos/auth0_dark_mode.png" width="150">
    <img alt="Auth0 Logo" src="https://cdn.auth0.com/website/sdks/logos/auth0_light_mode.png" width="150">
  </picture>
</p>
<p align="center">Auth0 is an easy to implement, adaptable authentication and authorization platform. To learn more checkout <a href="https://auth0.com/why-auth0">Why Auth0?</a></p>
<p align="center">
This project is licensed under the MIT license. See the <a href="https://github.com/auth0/auth0.js/blob/master/LICENSE"> LICENSE</a> file for more info.</p></article>
    </section>






</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Authentication.html">Authentication</a></li><li><a href="Management.html">Management</a></li><li><a href="Popup.html">Popup</a></li><li><a href="Redirect.html">Redirect</a></li><li><a href="WebAuth.html">WebAuth</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Mon Oct 06 2025 14:15:35 GMT+0530 (India Standard Time)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>